Skip to content

Point the changelog page at the corrections log - #30

Merged
bensynapse merged 1 commit into
mainfrom
docs/changelog-corrections-link
Nov 19, 2026
Merged

bensynapse merged 1 commit into
mainfrom
docs/changelog-corrections-link

Conversation

@bensynapse

Copy link
Copy Markdown
Member

The docs changelog lists changes to the specification. Corrections to published data values are a different thing. They now have their own page, the corrections log at https://livetennisapi.com/data/corrections.

This adds one paragraph to the changelog page header that links it:

Corrections to published data values are not spec changes, so they are listed in the corrections log.

Where it goes

build_changelog in scripts/build_reference.py writes the page header. The text above the first ## [x.y.z] heading in CHANGELOG.md is never rendered, so the line goes in the template, right after the existing header paragraph. docs/changelog.html is rebuilt. No other generated file changed.

There is no changelog entry and no version bump. Earlier docs-only changes to the templates did the same, such as the footer credit in #8.

Merge order

The corrections log is added by tennisv1 #140, which is not deployed yet. Until it is, the URL redirects to the homepage. Please merge this after tennisv1 #140 is live and /data/corrections returns 200.

Checks

  • python scripts/build_reference.py --check: generated docs are current
  • sh scripts/truthcheck.sh: OK
  • the contract step from lint.yml: OK, 48 paths, 49 operations, 66 schemas
  • npx @redocly/cli@latest lint openapi.yaml: valid
  • python -m unittest scripts/test_build_code_samples.py: 19 tests OK
  • python scripts/check_client_versions.py: 15 of 15 rows match
  • Screenshots at 1440px and 360px: the line sits under the header paragraph and wraps cleanly on a phone.

The changelog page lists changes to the specification. Corrections to
published data values now have their own page on livetennisapi.com.
A second paragraph in the page header links it.

The header is written in build_changelog. The text above the first
entry in CHANGELOG.md is not rendered, so the line goes in the
template. docs/changelog.html is rebuilt and nothing else changed.
There is no changelog entry or version bump, as with the earlier
docs-only changes to the page template.
@bensynapse
bensynapse merged commit 7fdd637 into main Nov 19, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant